dropdown/[root]

Package-level declarations

Types

data class AnimationProp(val enterDuration: Int, val exitDuration: Int, val delay: Int = 0, val easing: Easing, val initialAlpha: Float = 0.92f)

DropDownMenuBuilder

class DropDownMenuBuilder<T : Any>

DropDownMenuColors

data class DropDownMenuColors(val backgroundColor: Color, val contentColor: Color)

enum Easing : Enum<Easing>

Represents different easing options for animations.

enum EnterAnimation : Enum<EnterAnimation>

MetaphorEnterAnimation is the collection of the enter animations.

annotation class MenuDSL

data class MenuItem<T : Any>(val id: T? = null, val title: String = "")

Properties

val MAX_WIDTH: Dp

Functions

CascadeHeaderItem

fun CascadeHeaderItem(title: String, contentColor: Color, onClick: () -> Unit)

Represents a header item of the menu.

fun <T> ChildItem(id: T, title: String, icon: ImageVector?, contentColor: Color, onClick: (T) -> Unit)

Represents a child item of the menu.

fun <T : Any> Dropdown(modifier: Modifier = Modifier, isOpen: Boolean, menu: MenuItem<T>, colors: DropDownMenuColors = dropDownMenuColors(), offset: DpOffset = DpOffset.Zero, enter: EnterAnimation = EnterAnimation.FadeIn, exit: ExitAnimation = ExitAnimation.FadeOut, easing: Easing = Easing.FastOutLinearInEasing, enterDuration: Int = 500, exitDuration: Int = 500, onItemSelected: (T?) -> Unit, onDismiss: () -> Unit)

Dropdown is a DropdownMenu wrapper class to add cascade effect and animations.

DropdownContent

fun <T : Any> DropdownContent(targetMenu: MenuItem<T>, onItemSelected: (T?) -> Unit, colors: DropDownMenuColors, onParentClick: () -> Unit, onChildClick: (T) -> Unit)

Represents menu content properties for a dropdown menu.

fun <T : Any> dropDownMenu(init: DropDownMenuBuilder<T>.() -> Unit): MenuItem<T>

dropDownMenuColors

fun dropDownMenuColors(backgroundColor: Color = MaterialTheme.colors.surface, contentColor: Color = MaterialTheme.colors.onSurface): DropDownMenuColors

getAnimationSpec

fun getAnimationSpec(animationProp: AnimationProp): TweenSpec<Float>

getOffsetAnimationSpec

fun getOffsetAnimationSpec(animationProp: AnimationProp): FiniteAnimationSpec<IntOffset>

getPlatformName

actual fun getPlatformName(): String

expect fun getPlatformName(): String

actual fun getPlatformName(): String

actual fun getPlatformName(): String

fun MenuItem(onClick: () -> Unit, content: @Composable RowScope.() -> Unit)

Wrapper for handling onClick and user interaction for a dropdown MenuItem.

fun MenuItemIcon(icon: ImageVector, tint: Color)

Displays an icon for the MenuItem.

fun MenuItemText(modifier: Modifier, text: String, color: Color, isHeaderText: Boolean = false)

Displays text for the MenuItem.

fun <T> ParentItem(id: T, title: String, icon: ImageVector?, contentColor: Color, onClick: (T) -> Unit)

Represents a parent item of the menu.

fun Space()

Adds space content.